Skip to content

feat(sdk): add linter and fix linter findings #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 28 commits into
base: main
Choose a base branch
from
Open

feat(sdk): add linter and fix linter findings #39

wants to merge 28 commits into from

Conversation

rubenhoenle
Copy link
Member

@rubenhoenle rubenhoenle commented Oct 2, 2025 •
edited by Benjosh95
Loading

Description

relates to STACKITSDK-219

Checklist

  • Issue was linked above
  • No generated code was adjusted manually
  • Changelogs
    • Changelog in the root directory was adjusted
    • Changelog(s) of the service(s) were adjusted
  • VERSION file(s) of the service(s) were adjusted
  • Code format was applied: make fmt
  • Examples were added / adjusted (see examples/ directory)
  • Unit tests got implemented or updated
  • Unit tests are passing: make test (will be checked by CI)
  • No linter issues: make lint (will be checked by CI)

@rubenhoenle rubenhoenle requested a review from a team as a code owner October 2, 2025 10:11
@rubenhoenle rubenhoenle marked this pull request as draft October 2, 2025 10:11
Benjosh95 added 23 commits October 9, 2025 08:41
@Benjosh95
adapt pmd commentsize
7a3fb20
@Benjosh95
apply make fmt
700e032
@Benjosh95
shorten deprecated comments
5dff990
@Benjosh95
fix commentDefaultAccessModifier
7670547
@Benjosh95
fix pmd ImmutableField
bcf629a
@Benjosh95
fix pmd AvoidUncheckedExceptionsInSignatures
2e0f841
@Benjosh95
fix pmd AvoidThrowingRawExceptionTypes
dc61aa0
@Benjosh95
fix pmd avoidsynchronized statement or method
fba3469
@Benjosh95
fix pmd law-of-demeter in ruleset
62c44e0
@Benjosh95
fix pmd GuardLogStatement
d7aec54
@Benjosh95
fix pmd commentsize
c6b1de5
@Benjosh95
fix pmd SystemPrintln
92c9c3f
@Benjosh95
fix pmd commentsize
4c988e1
@Benjosh95
fix pmd commentsize
26134b3
@Benjosh95
fix pmd systemprintln, guardlogstatement
c1f8862
@Benjosh95
fix pmd AvoidThrowingRawExceptionTypes
071954b
@Benjosh95
fix pmd NPathComplexity
03f6849
@Benjosh95
rework fix pmd systemprintln, guardlogstatement
0eaef38
@Benjosh95
fix pmd AvoidThrowingRawExceptionTypes
53176a3
@Benjosh95
fix pmd UseUtilityClass
10a0662
@Benjosh95
fix pmd useutilityclass, refactor example class modifiers
a9cc5bc
@Benjosh95
fix pms useutilityclass classlevel
8330da9
@Benjosh95
apply make fmt
75ccc27
@Benjosh95 Benjosh95 marked this pull request as ready for review October 9, 2025 18:38
rubenhoenle
rubenhoenle commented Oct 14, 2025
View reviewed changes
rubenhoenle
rubenhoenle commented Oct 15, 2025
View reviewed changes
core/src/main/java/cloud/stackit/sdk/core/KeyFlowAuthenticator.java
accessToken = getAccessToken();
} catch (ApiException | InvalidKeySpecException e) {
throw new RuntimeException(e);
throw new IllegalStateException(e);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if a IllegalStateException is correct here.

From https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html: "Signals that a method has been invoked at an illegal or inappropriate time. In other words, the Java environment or Java application is not in an appropriate state for the requested operation."

I think I also saw this in multiple places, so please also check if the IllegalStateException is appropriate there.

rubenhoenle
rubenhoenle commented Oct 15, 2025
View reviewed changes
core/src/main/java/cloud/stackit/sdk/core/KeyFlowInterceptor.java
// try-catch required, because ApiException can not be thrown in the implementation
// of Interceptor.intercept(Chain chain)
throw new RuntimeException(e);
throw new IllegalStateException(e);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

e.g. here

rubenhoenle
rubenhoenle commented Oct 15, 2025
View reviewed changes
...ntication/src/main/java/cloud/stackit/sdk/authentication/examples/AuthenticationExample.java
throw new RuntimeException(e);
System.out.println(response.toString());
} catch (ApiException | IOException e) {
throw new IllegalStateException(e);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

rubenhoenle
rubenhoenle commented Oct 15, 2025
View reviewed changes
examples/iaas/src/main/java/cloud/stackit/sdk/iaas/examples/IaaSExample.java

} catch (ApiException | InterruptedException e) {
throw new RuntimeException(e);
throw new IllegalStateException(e);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Benjosh95 Benjosh95 Benjosh95 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@rubenhoenle @Benjosh95